﻿/*
 * DG (DG Gaming Engine)  - API
 * Copyright (C) 2004  Bob Marks (marksie531@yahoo.com)
 * http://code.google.com/p/dng-gaming
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
package com.dg.gaming.api.common.msg
{
	import nanoxml.XMLElement;
	import com.dg.gaming.api.common.TransmissionException;

	/**
	 * Communication class which is used to invite a user to a table.
	 *
	 * @author  Bob Marks
	 * @version Alpha 0.2.3
	 */
	public class MsgInvite extends MsgGameMessage
	{

		/** User requests invite to a user. */
		public static const REQUEST:int=1;

		/** User accepts invite from a user. */
		public static const ACCEPT:int=2;

		/** User declines invite from. */
		public static const DECLINE:int=3;

		/** Table number. */
		protected var tableNum:String;

		// Declare XML attributes
		private static const XML_ATT_TABLE_NUM:String="tableNum";

		/**
		 * Constructor which creates a CommInvite object from the flatten () method of
		 * another CommInvite object.
		 *
		 * @param message                     XML element version of object.
		 * @throws TransmissionException      Thrown if problem in transmission
		 */
		public function MsgInvite(status:int=-1, tableNum:String=null, usernameTo:Number=-1, message:XMLElement=null)
		{

			initStatus(status);
			setUseridTo(usernameTo);
			this.tableNum=tableNum;
			if (message != null)
				super(message);

			if (message == null)
			{
				return;
			}
			if (message.name != (Msg.INVITE))
			{
				throw new TransmissionException("Error parsing invite string.");
			}

			this.tableNum=message.getStringAttribute(XML_ATT_TABLE_NUM);
		}

		/**
		 * Flatten this offer draw object.
		 *
		 * @see com.dg.gaming.api.common.msg.ITransmittable#flatten()
		 */
		public override function flatten():XMLElement
		{
			var message:XMLElement=flattenWithName(Msg.INVITE);
			message.setAttribute(XML_ATT_TABLE_NUM, tableNum);

			return message; // flatten XML to a String
		}

		/**
		 * Return the table number.
		 *
		 * @return   Table number.
		 */
		public function getTableNum():String
		{
			return tableNum;
		}
	}
}